home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 26 / Cream of the Crop 26.iso / bbs / pentas20.zip / PENTAS20.EXE / DOCS / PENTASIM.DOC < prev    next >
Text File  |  1997-08-20  |  15KB  |  317 lines
  1.             ─────────────────────────────────────────────────────
  2.                              PENTASIM  v2.0
  3.  
  4.                       (C)1997 Sunrise Door Software
  5.                          Written by: Al Lawrence
  6.                             
  7.                             BBS: 404-256-9525
  8.                       Email: al_lawre@ix.netcom.com
  9.                    Voice: 404-256-9518 (9am-9:30pm EST/EDT)
  10.                    WWW: http://www.netcom.com/~al_lawre
  11.                            Fido: 1:133/6003
  12.             ─────────────────────────────────────────────────────
  13.     
  14.      
  15.             ─────────────────────────────────────────────────────
  16.                               PENTASIM Features:
  17.             ─────────────────────────────────────────────────────
  18.  
  19.              - DROP FILE SUPPORT:
  20.                ─────────────────
  21.                 
  22.                 - DOOR.SYS       (DOOR.SYS compatible systems)
  23.                 - DORINFOx.DEF   (QBBS/RBBS/Remote Access systems)
  24.                 - PCBOARD.SYS    (PCBOARD systems)
  25.                 - SFDOORS.DAT    (Spitfire systems)
  26.                 - CALLINFO.BBS   (Wildcat previous to v3.0 systems)
  27.         
  28.              - MULTINODE SUPPORT:
  29.                ───────────────── 
  30.                 
  31.                 - Error handling routines to save data from becoming corrupt
  32.                 - Files accessed quickly and effeciently
  33.                 - Read-only files opened in shared mode for quicker operation
  34.                 - Highly used data files are copied to a temp data file with
  35.                   a node number extension to free up these files for other 
  36.                   processes
  37.              
  38.              - SYSOP SCRIPT FILES SUPPORT:
  39.                ────────────────────────── 
  40.              
  41.                 - Easy to use Scripting Language allows each Sysop to
  42.                   customize their game
  43.                 - Quickly & easily install and UNinstall Script Files
  44.                 - Quickly test and debug your Script Files
  45.                 - Sysop can install up to 21 Script Files  
  46.              
  47.              - BASIC DOORGAME SUPPORT:
  48.                ──────────────────────
  49.                 
  50.                 - Watches callers time and logs them off when they exceed it
  51.                 - Automatically recycles back to BBS upon loss of carrier
  52.                 - Inactivity time out watch of 240 seconds(4 minutes)
  53.         
  54.              - EASY INSTALL & CONFIGURATION UTILITY ALLOWS YOU TO:
  55.                ──────────────────────────────────────────────────  
  56.                 
  57.                 - Install PENTASIM quickly & easily
  58.                 - Reconfigure nodes quickly & easily
  59.                 - Reset the game
  60.                 - Featuring FULL MOUSE Support
  61.                 - Easy Node to Node passing of entries
  62.              
  63.              - GAME SPECIFIC FEATURES:
  64.                ──────────────────────  
  65.                 
  66.                 - No DEMO KEY FILES required
  67.                 - Checking for user entered BADWORDS(can be disabled)
  68.                 - Tested under a variety of operating systems including:
  69.                   DOS, OS/2, DESQview, WINDOWS 3.x and WINDOWS 95.
  70.  
  71.              
  72.              
  73.              TABLE OF CONTENTS
  74.             ─────────────────────────────────────────────────────
  75.              Warranty...........................................1
  76.              Usage..............................................2
  77.              Distribution.......................................3
  78.              Description........................................4
  79.              Registration Information...........................5
  80.              Shareware vs Registered............................6
  81.              System Requirements................................7
  82.              Installation.......................................8
  83.              Running the Program................................9
  84.              Fossil Driver Support.............................10
  85.              Environment Variables.............................11
  86.              Up & Running......................................12
  87.              Using the Scripting Language......................13
  88.              Errors & Other Problems...........................14
  89.             ─────────────────────────────────────────────────────
  90.  
  91.  
  92.      
  93.      ┌─WARRANTY────────────────────────────────────────────────────1─┐
  94.      └───────────────────────────────────────────────────────────────┘
  95.  
  96.      This product is provided "as is" without warranty of any kind. 
  97.      The entire risk as to the results and performance of the program 
  98.      is assumed by you.  Futhermore, the author does not warrant, 
  99.      guarantee, or make any other representations regarding the use 
  100.      of, or the results of the use of the program, and you rely on the 
  101.      program and results solely at your own risk. The author cannot 
  102.      and will not accept responsibility for system damage, loss of 
  103.      profit, or any other special, consequential or incidental damages 
  104.      resulting from the use or inability to use this product.
  105.  
  106.  
  107.      ┌─USAGE───────────────────────────────────────────────────────2─┐
  108.      └───────────────────────────────────────────────────────────────┘
  109.  
  110.      This product is being distributed as Shareware. Under this 
  111.      concept you may use the SHAREWARE (unregistered) version for a 
  112.      reasonable period for evaluation, after which you MUST either 
  113.      register your copy or discontinue usage.  
  114.  
  115.      
  116.      ┌─DISTRIBUTION────────────────────────────────────────────────3─┐
  117.      └───────────────────────────────────────────────────────────────┘
  118.  
  119.      You are encouraged to distribute this copy of PENTASIM provided 
  120.      the archive is kept in its original and unmodified state. 
  121.  
  122.  
  123.      ┌─DESCRIPTION─────────────────────────────────────────────────4─┐
  124.      └───────────────────────────────────────────────────────────────┘
  125.  
  126.      PENTASIM is a true Multinode, RPG adventure style door game that
  127.      will have your users coming back for more and more each day!
  128.  
  129.      For details on the FULL game story and what each player can 
  130.      expect each day when playing PENTASIM, please see STORY.DOC.
  131.  
  132.  
  133.      ┌─REGISTRATION─INFORMATION────────────────────────────────────5─┐
  134.      └───────────────────────────────────────────────────────────────┘
  135.  
  136.      There are a couple of ways in which you can register PENTASIM 
  137.      and receive your individual key file, which will allow the 
  138.      program to operate in FULL registered mode.  Look for details on 
  139.      how to do this in the file: REGISTER.FRM included with this 
  140.      archive.
  141.  
  142.  
  143.      ┌─SHAREWARE─VS─REGISTERED─────────────────────────────────────6─┐
  144.      └───────────────────────────────────────────────────────────────┘
  145.  
  146.      THERE ARE NO DEMO KEYS REQUIRED in the UNREGISTERED version of 
  147.      PENTASIM.  The SHAREWARE version of PENTASIM has a couple of 
  148.      limitations as opposed to the REGISTERED version.  Users can only 
  149.      reach 50,000 Kilometers before their stats are reset. The game 
  150.      CANNOT be won in UNREGISTERED MODE!  As well, the standard 
  151.      configuration will be used unless the game is registered.  
  152.      Ex.  Cyborg Battles, Starting Kroons, etc.   
  153.  
  154.      These limitations are not in place to be annoying, just to 
  155.      encourage registration of the product to cover the cost of 
  156.      programming time and support.  Future versions, updates, and 
  157.      support of PENTASIM are yours FREE with Registration.
  158.  
  159.                               
  160.      ┌─SYSTEM─REQUIREMENTS─────────────────────────────────────────7─┐
  161.      └───────────────────────────────────────────────────────────────┘
  162.  
  163.      ANSI.SYS MUST be loaded in your CONFIG.SYS.  Users who are using 
  164.      some other type of ANSI emulation may get the system to work...
  165.      Ex. DVANSI.  This should be loaded at system boot up, not just in 
  166.      each process or window.
  167.      
  168.      SHARE.EXE MUST be loaded in your CONFIG.SYS.
  169.  
  170.      DOS 5.0 or later.
  171.  
  172.  
  173.      ┌─INSTALLATION────────────────────────────────────────────────8─┐
  174.      └───────────────────────────────────────────────────────────────┘
  175.  
  176.      Installation of PENTASIM is very simple.  Move the PENTASxx.ZIP 
  177.      file into whatever directory you plan to run PENTASIM from and 
  178.      and UNZIP it. Then type:  PENTASxx.EXE -d. This will create the 
  179.      subdirectories it needs to operate, so moving it to its planned 
  180.      directory is the way to go here.
  181.  
  182.      Type "PENTCFG" at the DOS Prompt in your PENTASIM directory.  
  183.      This will start PENTASIM CONFIGURATION UTILITY and get you on 
  184.      your way.  The program is very self explanatory.
  185.  
  186.      You can use your arrow keys to move around as well as your TAB
  187.      key if you prefer to use the keyboard.  ENTER will select an
  188.      item.  The Configuration Utility features full MOUSE support as
  189.      well if you prefer a mouse.
  190.      
  191.      When configuring for each node in PENTCFG.EXE, it will create a 
  192.      NODEx.CFG file for each node, where x represents the node number.
  193.  
  194.      Add a call to PMAINT.EXE in your nightly event batch file.  
  195.      PMAINT.EXE NEEDS to be called once a night.  PMAINT.EXE will
  196.      delete inactive players and add interest to each players Bank
  197.      Station Account.  Players are deleted after 14 days of inactivity.
  198.      PMAINT.EXE is fully multinode as well and can be run even if
  199.      someone is in the game.  Be sure that PMAINT.EXE resides in your
  200.      main PENTASIM directory and you change to that directory, before 
  201.      you call PMAINT.
  202.      
  203.      
  204.      ┌─RUNNING─THE─PROGRAM─────────────────────────────────────────9─┐
  205.      └───────────────────────────────────────────────────────────────┘
  206.  
  207.      This part is basically up to you.  Depending on which BBS program 
  208.      you are running, the .BAT file may look a little different.  
  209.      Refer to your BBS Manual for information on running Doors from 
  210.      your BBS.  We will use a sample .BAT file which would run 
  211.      PENTASIM from a Wildcat System:
  212.  
  213.      DOOR10.BAT
  214.      ──────────
  215.  
  216.      CD\DOORS\PENTASIM              <- Call to directory
  217.      PENTASIM NODEx.CFG             <- Call to main .EXE and .CFG file
  218.      CD\WILDCAT                     <- Call back to the BBS
  219.  
  220.  
  221.      The x reflects the NODE NUMBER that the program is being called 
  222.      from.  The DEFAULT is NODE1.CFG.  If you are running a single 
  223.      line BBS, then this is the number you should be using.
  224.  
  225.  
  226.      ┌─FOSSIL─DRIVER─SUPPORT──────────────────────────────────────10─┐
  227.      └───────────────────────────────────────────────────────────────┘
  228.  
  229.      PENTASIM also supports the use of Fossil drivers.  To tell it 
  230.      to use the Fossil Driver instead of the standard COM ports, just 
  231.      put /FD on the command line when running the door. For example:
  232.      
  233.      PENTASIM NODEx.CFG /FD
  234.  
  235.      indicates that a Fossil driver is present and should be used. 
  236.      
  237.      *** NOTE:  No fossil driver is needed to run this door.  If you 
  238.                 are operating on standard COM ports and IRQ's, then 
  239.                 use of the fossil driver is NOT REALLY NEEDED.
  240.  
  241.  
  242.      ┌─ENVIRONMENT─VARIABLES──────────────────────────────────────11─┐
  243.      └───────────────────────────────────────────────────────────────┘
  244.  
  245.      PENTASIM supports COM 1 - 4 on the standard IRQ's - COM1/COM3 = 
  246.      IRQ4 and COM2/COM4 = IRQ3.  PENTASIM WILL support COM 0 - 15.  
  247.      If you wish to use a non-standard IRQ, add the IRQ number after 
  248.      the configuration filename.  Let's assume you want to use COM1 
  249.      and IRQ5. The command line passed in the .BAT file would be:
  250.     
  251.      PENTASIM NODEx.CFG /5  or
  252.      PENTASIM NODEx.CFG /%IRQ%   <- for the environment variable.
  253.  
  254.      The /5 tells PENTASIM to use IRQ5 rather than the standard 
  255.      IRQ4 that is normally used with COM1. No /x parameter is needed 
  256.      for the standard IRQ's.
  257.  
  258.  
  259.      ┌─UP─AND─RUNNING─────────────────────────────────────────────12─┐
  260.      └───────────────────────────────────────────────────────────────┘
  261.  
  262.      Once PENTASIM is up and running it should basically take care 
  263.      of itself and will require no maintenance from you, other than the  
  264.      daily call to PMAINT.EXE.  Instructions on using the game are in 
  265.      the Door itself and are pretty self explanatory.
  266.  
  267.      You can RESET the entire game by using the included PENTCFG.EXE.  
  268.  
  269.      If a player reaches the Pentasim, their alias and the date that
  270.      they WON will be written to a file called HEROS.DAT.  Players
  271.      can view who has won at the (I)nformation Centre.  If you wish
  272.      to delete this file at any time you can do so to reset the HEROS
  273.      of the game.
  274.      
  275.      If at any time you wish to change the configuration for any node, 
  276.      then simply run PENTCFG.EXE again.   
  277.  
  278.  
  279.      ┌─USING THE SCRIPTING─LANGUAGE───────────────────────────────13─┐
  280.      └───────────────────────────────────────────────────────────────┘
  281.      
  282.      For FULL details on writing your own Scripts for PENTASIM, see
  283.      SCRIPTS.DOC included with this archive.
  284.      
  285.      
  286.      ┌─ERRORS─AND─OTHER─PROBLEMS──────────────────────────────────14─┐
  287.      └───────────────────────────────────────────────────────────────┘
  288.  
  289.      If unusual ERROR's seem to be cropping up right off that start of 
  290.      PENTASIM like a keyboard timeout when the user or even YOU 
  291.      enter the door, there is an easy fix for this problem. Simply 
  292.      place the following line in your AUTOEXEC.BAT file:
  293.  
  294.      SET NO87=ON
  295.  
  296.      One other important thing to note is if you for some reason use 
  297.      the F5 key (SHELL to DOS) while a user is online, before typing 
  298.      "EXIT" to return back into the program, you should always make 
  299.      your way back to the directory that the F5 key dropped you into.  
  300.      Otherwise, PENTASIM won't know how to make its way back to 
  301.      where it needs to be!  This is a routine written by the author of 
  302.      the DOOR LIBRARY, which I have no control over!
  303.  
  304.      ANY other ERROR's while the door is in operation will be written 
  305.      to a file called PENTASIM.ERR.  This ERROR log will be written in 
  306.      the main PENTASIM directory.
  307.  
  308.      If for some reason you see the door say "You need ANSI to use 
  309.      this door!" upon logon and you DO have ANSI enabled, you most 
  310.      likely are running in a DESQview or WINDOWS environment.  It is 
  311.      not good enough to load your ANSI emulator (ANSI.SYS is preferred) 
  312.      in each session or screen, it MUST be loaded upon system start 
  313.      up.  The ANSI routines again, are written by the LIBRARY author, 
  314.      not myself.  I do not have any control over this. :)
  315.  
  316.  
  317.